User Guide

This user guide provides application information about Automation Catalog.

Accessing the Application

The primary ways to access the application are:

• From the home screen, locate the Automation Catalog icon card.

  

• Navigate to the Applications menu and select Automation Catalog.

  

After accessing Automation Catalog, a list of available automations will display in card format.

Create New Automation

To create a new automation:

1. Click the plus (+) icon on the blank card.

Note: See the image of the main canvas above in Accessing the Application.

1. Provide a name for the new automation.

Edit an Automation

To edit an automation:

1. Click the stacked dots button (lower-right corner).

2. Select Edit.

   

3. The Automation Details page displays. From this view, you can modify several attributes within an automation.

   

Automation Permissions

Click the cog icon in the top toolbar of the Details page to open the Access Management panel, which allows you to assign user groups authorized to change and/or view an automation. By default, group permissions are not automatically assigned, which grants all users authorization to change, view, and execute an automation.

• To assign Read-Write permissions to a group, use the dropdown control box. Once a group selection is made, click Save.
• Groups with Write permissions are authorized to change, view, and execute an automation while Read-only groups have permission only to view and execute.
• If a Write group or Read-only group is set, then the counterpart group must also be defined; in other words, a Write group cannot be configured without at least one group specified as Read-only and vice versa.

Run an Automation

There are two ways to run an automation:

Method 1

1. From the Automations page, click the stacked dots menu button.

2. Select Run.

   

3. Input the form-data, if required. Then click Run.

   

Method 2

1. Select an automation from the Automations sidebar.

   

2. Select Run Manually.

   

3. Input the form-data, if required. Then click Run.

Note: Refer to the image after Step 3 in Method 1 above.

Schedule an Automation

1. Select an automation from the Automations sidebar.

   

2. Enable scheduling by toggling the Schedule switch.

   

3. Fill out and save form-data, if needed.

   

4. Select a future date/time and how often the schedule should repeat. Then click Apply.

   

Attributes

Use the following attributes to set an automation.

Attribute	Description
Groups	Write: Group of users that can modify the automation details. Read: Group of users that can view and run an automation.
Workflow	Select the workflow that will run when the automation is triggered.
Form	If a workflow needs input data (i.e., device name), select a form that will capture this data from users that trigger the automation. You can edit/create forms by clicking the corresponding buttons, which opens the JSON Forms application.
Run At	To schedule an automation to be triggered at a certain date and time, use the calendar (date) and clock (time) icon.
Repeats	Based on the date and time set in the Run At field, select a recurring interval for triggering the automation.

Form Data

If a form is selected, it will display on the right side of the screen. For a scheduled automation, form data is required to start the workflow.

• Complete the form fields (name and description).
• Click Save Form Data.

The form data is passed into a workflow through a field called formData, which is available as a job variable in Workflow Builder. You can use the query task in Workflow Builder to access data that is stored in different containers within the formData object.

Of note, the formData object will not appear as a job variable option initially.

It must be added manually using the EDIT button to the right of the job options.

Once the formData option is added manually, it will be available as a job option in other tasks throughout the automation.